| Fully Qualified Name: | Laminas\Db\Sql\Join |
| Implements: | Iterator, Countable |
Aggregate JOIN specifications.
Each specification is an array with the following keys:
Select::SQL_STAR.JOIN_* constants;
defaults to JOIN_INNER| Name | Description | Defined By |
|---|---|---|
| __construct() | Initialize iterator position. | Join |
| count() | Get count of attached predicates | Join |
| current() | Return current join specification. | Join |
| getJoins() | Join | |
| join() | Join | |
| key() | Return the current iterator index. | Join |
| next() | Advance to the next JOIN specification. | Join |
| reset() | Reset to an empty list of JOIN specifications. | Join |
| rewind() | Rewind iterator. | Join |
| valid() | Is the iterator at a valid position? | Join |
Initialize iterator position.
Returns:
Get count of attached predicates
Returns: int
Return current join specification.
Returns: array
Returns: array
| Parameter Name | Type | Description |
|---|---|---|
| $name | string|array|\TableIdentifier | A |
| $on | string|\Predicate\Expression | A |
| $columns | string|string[]|int|int[] | A |
| $type | string | The |
Returns: self Provides a fluent interface
Return the current iterator index.
Returns: int
Advance to the next JOIN specification.
Returns:
Reset to an empty list of JOIN specifications.
Returns: self Provides a fluent interface
Rewind iterator.
Returns:
Is the iterator at a valid position?
Returns: bool